VoiceForm Web Services

VoiceCheck exposes a web service that allows the creation of a VoiceForm—essentially a data import. This web service enables creating new VoiceForms as well as updating and deleting existing VoiceForms from the VoiceCheck server. When this web service is invoked, VoiceCheck validates the system for the following:

• If there is no matching VoiceForm name, a new VoiceForm is created.
• If there is a matching VoiceForm name, a new VoiceForm is not created.

A VoiceForm can be imported with or without any VoiceForm steps. This allows a technician to create the VoiceForm steps later, from the VoiceCheck server.

When VoiceCheck receives this message for reading, updating, and deleting of VoiceForms, the following validations are taken into consideration:

• If the VoiceForm name does not exist in VoiceCheck, no details are returned in the response.
• If the VoiceForm exists, the web service can update only the name of the VoiceForm.
• If the VoiceForm does not reference to any other entity in VoiceCheck, it can be deleted. Otherwise VoiceForm deletion is not permitted.

Create VoiceForm Details

REST Web Service

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform

Method: POST

Content-Type: application/json;charset=UTF-8

Message Body: JSON as outlined in the schema in the WADL. The elements are described in the input elements table.

Response: On success, HTTP Status 200 with Payload “VoiceForm saved”. On failure, the system returns an error. Any HTTP status code other than 200 or 204 is considered an error. When possible, the host system should return a body for errors.

POST Parameters

A VoiceForm file with valid parameters in the body.

READ VOICEFORM DETAILS

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

Method: GET

Content-Type: application/json;charset=UTF-8

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

UPDATE VOICEFORM DETAILS

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/update/{voiceformname}/{newvoiceformname}

Method: POST

Content-Type: application/json;charset=UTF-8

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

DELETE VOICEFORM DETAILS

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

Method: DELETE

Response: On success, HTTP Status 200 with or without a body. On failure, the system returns an error.

Manage Images

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/imageService?_wadl

URL: <http or https>://<VoiceCheckIP>:<port>/VoiceCheck/services/imageService/<Directory/Folder Name><Directory/Folder Name>.....<photo filename with extension>

Method: GET

Parameter: image path in the file system with image name (parameter is sent in the URL)

Content-Type: (blank)

Response: On success, HTTP Status 200. When photo is not found, the service generates a WebAppplicationException with status HTTP Status 404 Not Found.

Basic Authentication: VoiceCheck User Name and Password

INPUT ELEMENTS

PROPERTY	TYPE	REQ’D	DEFINITION	VALIDATION
voiceformname	String	Yes	The name of the VoiceForm	Must be unique in VoiceCheck